DOM SAX StAX

July 18, 2019

都现在了，我也没有想到自己又回到十年前重新又碰Java解析XML，现在一个老项目中间正好用到，自己也算复习一下。

DOM

DOM（Document Object Model）是第一种解析办法，也是最早的一种，基本就是把整个XML文件都读到内存中去构造树结构，然后再进行增删改查。主要的缺点就是对待大的XML文件无能为力。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;

// ...

DocumentBuilderFactory df;
DocumentBuilder builder;
Document document;

try {
    // Obtain DocumentBuilder factory
    df = DocumentBuilderFactory.newInstance();
    
    // Get DocumentBuilder instance from factory
    builder = df.newDocumentBuilder();
    
    // Document object instance now is the in-memory representation of the XML file
    document = builder.parse("src/students.xml");
} catch (Exception e) {
    e.printStackTrace();
}

这种解析办法已经包含在JDK/JAXP中了。　另外还有JDOM 和 DOM4J

SAX

SAX(Simple API for XML)是边解析边推送，用户可以根据预先定义的callback来对推送的解析内容进行处理，优点就是内存不是问题了。但是由于它使用的推模式，也就是我们无法控制解析过程，给我们什么我们就用什么，无法暂停，也无法做些特殊处理。

import java.util.ArrayList;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.xml.sax.XMLReader;

public class SAXDemo {
    public static void main(String[] args) {
        ArrayList<BookBean> bookList = null;
        BookHandler bookHandler = new BookHandler();
        
        SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
        SAXParser saxParser;
        
        try {
            saxParser = saxParserFactory.newSAXParser();
            
            XMLReader xmlReader = saxParser.getXMLReader();
            xmlReader.setContentHandler(bookHandler);
            xmlReader.parse("src/Books.xml");
            
            /* or */
            // saxParser.parse("src/Books.xml", bookHandler);
        } catch (Exception e) {
            e.printStackTrace();
        }
        
        bookList = bookHandler.getBookList();
        
        if (bookList != null) {
            for (BookBean book : bookList) {
                System.out.println(book);
            }
        }
    }
}

Handler就是callback，包含三个方法，需要仔细定义。比如：

import java.util.ArrayList;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class BookHandler extends DefaultHandler {

    private String mCurrentTagName;
    private BookBean mBook;
    
    private ArrayList<BookBean> mBookList = new ArrayList<BookBean>();
    
    @Override
    public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
        
        // Remember the current element tag
        this.mCurrentTagName = qName;
        
        // If current tag is a new book element item, create a new BookBean object
        if ("book".equals(this.mCurrentTagName)) {
            this.mBook = new BookBean();
            this.mBook.setISBN(attributes.getValue("ISBN"));
        }
    }
    
    @Override
    public void characters(char[] ch, int start, int length) throws SAXException {
    
        if ("book".equals(this.mCurrentTagName)) {
            String name = new String(ch, start, length);
            this.mBook.setName(name);
        }
        
    }
    
    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {
    
        // If parsing of a book item is finished, add it to the list and reset mBook
        if ("book".equals(qName)) {
            this.mBookList.add(this.mBook);
            this.mBook = null;
        }
        
        // Reset current element tag
        this.mCurrentTagName = null;
    }
    
    public ArrayList<BookBean> getBookList() {
        return this.mBookList;
    }
}

这种解析办法也已经包含在JDK/JAXP中了。　另外还有Xerces

StAX

这个是后来出现的解析办法，采用的是拉模式，这样就会比较灵活，另外由于和SAX一样采用流处理，所需内存也不大。

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.util.Iterator;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.Attribute;
import javax.xml.stream.events.Characters;
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

public class StAXEventReaderExample {
    public static void main(String[] args) throws XMLStreamException,
            FileNotFoundException {
        XMLInputFactory factory = XMLInputFactory.newInstance();
        XMLEventReader reader = factory.createXMLEventReader("sample.xml",
                new FileInputStream("src/com/javarticles/jaxp/sample.xml"));

        while (reader.hasNext()) {
            XMLEvent event = reader.nextEvent();
            if (event.isStartElement()) {
                StartElement element = (StartElement) event;
                System.out.println("Start Element: " + element.getName());

                Iterator iterator = element.getAttributes();
                while (iterator.hasNext()) {
                    Attribute attribute = (Attribute) iterator.next();
                    QName name = attribute.getName();
                    String value = attribute.getValue();
                    System.out.println("Attribute name/value: " + name + "/"
                            + value);
                }
            }
            if (event.isEndElement()) {
                EndElement element = (EndElement) event;
                System.out.println("End element:" + element.getName());
            }
            if (event.isCharacters()) {
                Characters characters = (Characters) event;
                System.out.println("Text:[" + characters.getData() + "]");
            }
        }
    }
}

这种解析办法是现在Java主流的解析办法，也包含在JDK中了 --- JSR-173。

DOM vs SAX vs StAX


Feature	StAX	SAX	DOM	TrAX
API Type	Pull, streaming	Push, streaming	In memory tree	XSLT Rule
Ease of Use	High	Medium	High	Medium
XPath Capability	No	No	Yes	Yes
CPU and Memory Efficiency	Good	Good	Varies	Varies
Forward Only	Yes	Yes	No	No
Read XML	Yes	Yes	Yes	Yes
Write XML	Yes	No	Yes	Yes
Create, Read, Update, Delete	No	No	Yes	No

JAXP vs JAXB

JAXB 要比JAXP 更抽象一点，更高一点。它不仅提供了Java对象和xml对象的解析，也提供了绑定，这样就可以不局限在底端解析的细节上了。从这个意义上来说。JAXP 已经过时。


Java Version	JAXP Version	JAXB Version	jaxb2-maven-plugin Version
1.4	1.1
5.0	1.3
6.0	1.4	2.0.3
7.0	1.4.5	2.2.4-1
7.40	1.5
8.0	1.6	2.2.8	2.3(match JAXB 2.2.11)
9.0		2.3.0	2.4

今天的情况

今天是项目中用到了一个老的SAX库 ---- Xerces 1.2.3，xml文件压缩后还有1个多G, 导致每次解析到80,000条记录时就报错.

Caused by: java.lang.RuntimeException: Internal Error: fPreviousChunk == NULL
	at org.apache.xerces.utils.UTF8DataChunk.addSymbol(UTF8DataChunk.java:389)
	at org.apache.xerces.readers.UTF8Reader.addSymbol(UTF8Reader.java:124)
	at org.apache.xerces.framework.XMLDocumentScanner$ContentDispatcher.dispatch(XMLDocumentScanner.java:1315)
	at org.apache.xerces.framework.XMLDocumentScanner.parseSome(XMLDocumentScanner.java:381)
	at org.apache.xerces.framework.XMLParser.parse(XMLParser.java:948)
	... 31 more

升级到1.4.4也不行，干脆把这个依赖去掉，也就是使用JDK自带的SAX库，就解决问题了。

Update 2019/07/23 结果发现jaxb2-maven-plugin失败，出现下面的错误

[ERROR] [SchemaGen]: Jul 23, 2019 3:48:13 PM com.sun.xml.bind.v2.util.XmlFactory createParserFactory
SEVERE: null
org.xml.sax.SAXNotRecognizedException: http://javax.xml.XMLConstants/feature/secure-processing
	at org.apache.xerces.parsers.AbstractSAXParser.setFeature(Unknown Source)
	at org.apache.xerces.jaxp.SAXParserImpl.setFeatures(Unknown Source)
	at org.apache.xerces.jaxp.SAXParserImpl.<init>(Unknown Source)
	at org.apache.xerces.jaxp.SAXParserFactoryImpl.newSAXParserImpl(Unknown Source)
	at org.apache.xerces.jaxp.SAXParserFactoryImpl.setFeature(Unknown Source)

原来测试也引入了另外一个版本的Xerces 2.4.0，移掉就好了。

[INFO] +- com.mockrunner:mockrunner-jdbc:jar:2.0.1:test
[INFO] |  \- com.mockrunner:mockrunner-core:jar:2.0.1:test
[INFO] |     +- jdom:jdom:jar:1.0:compile
[INFO] |     +- oro:oro:jar:2.0.8:test
[INFO] |     +- com.kirkk:jaranalyzer:jar:1.2:test
[INFO] |     |  +- bcel:bcel:jar:5.1:test
[INFO] |     |  |  \- regexp:regexp:jar:1.2:test
[INFO] |     |  +- jakarta-regexp:jakarta-regexp:jar:1.4:test
[INFO] |     |  \- ant:ant:jar:1.6.5:test
[INFO] |     \- nekohtml:nekohtml:jar:0.9.5:test
[INFO] |        \- xerces:xercesImpl:jar:2.4.0:test

根据这位大婶的建议，尽量去掉所有对Xerces的依赖。因为我们已经看到JDK中已经有最经过实践检验的版本了。我的这次经历验证了这一点。

为艺术而技术

DOM SAX StAX

DOM

SAX

StAX

DOM vs SAX vs StAX

JAXP vs JAXB

今天的情况

感谢